The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormRequest450 COM module


/images/arrow_right.png IForms::StartUpdate method space
With the change to an automatic, concurrent and externally running update process this method became a NOOP method except for the returned status.

If there is a principle problem with the update process (e.g. the local firewall blocks the update process) then the returned status is VARIANT_FALSE und GetAbortInfo() supplies the inability for updating the form template space.

So it is of uttermost importance that StartUpdate is called on a regular basis such that existing problems with the update process can be signaled back to the calling main process.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IForms/StartUpdate
[JSON input data] pIForms: longValue,    //interface address
[JSON result data] peUpdateNecessary:
pbStatus:		 longValue,
booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT StartUpdate( YesNoType
VARIANT_BOOL 		*peUpdateNecessary,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.
space
/images/arrow_right.png Calling argument description
[out] YesNoType *peUpdateNecessary Boolean value that denotes if an update was started (enYes) or if the update is unnecessary (enNo).

Patch: *peUpdateNecessary = enNo is fixed returned!
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
space